docs: remove STMT2

This commit is contained in:
Alex Duan 2024-12-30 17:16:23 +08:00
parent f6b180ff56
commit 62d3df49d1
1 changed files with 34 additions and 31 deletions

View File

@ -52,6 +52,7 @@ Python Connector 历史版本(建议使用最新版本的 `taospy`
| Python Connector 版本 | 主要变化 | TDengine 版本 | | Python Connector 版本 | 主要变化 | TDengine 版本 |
| -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------- | | -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------- |
| 2.7.20 | Native 支持 STMT2 写入 | - |
| 2.7.19 | 支持 Apache Superset 连接 TDengine Cloud 数据源 | - | | 2.7.19 | 支持 Apache Superset 连接 TDengine Cloud 数据源 | - |
| 2.7.18 | 支持 Apache Superset 产品连接本地 TDengine 数据源 | - | | 2.7.18 | 支持 Apache Superset 产品连接本地 TDengine 数据源 | - |
| 2.7.16 | 新增订阅配置 (session.timeout.ms, max.poll.interval.ms) | - | | 2.7.16 | 新增订阅配置 (session.timeout.ms, max.poll.interval.ms) | - |
@ -248,41 +249,43 @@ TaosResult 对象可以通过循环遍历获取查询到的数据。
- `reqId`: 用于问题追踪。 - `reqId`: 用于问题追踪。
- **异常**:操作失败抛出 `DataError` 或 `OperationalError` 异常。 - **异常**:操作失败抛出 `DataError` 或 `OperationalError` 异常。
#### 参数绑定 STMT2 #### 参数绑定
- `def statement2(self, sql=None, option=None)` - `fn statement(&self) -> PyResult<TaosStmt>`
- **接口说明**:使用连接对象创建 stmt2 对象 - **接口说明**:使用 连接 对象创建 stmt 对象。
- **参数说明** - **返回值**stmt 对象。
- `sql`: 绑定的 SQL 语句,如果不为空会调用`prepare`函数
- `option` 传入 TaosStmt2Option 类实例选项
- **返回值**stmt2 对象。
- **异常**:操作失败抛出 `ConnectionError` 异常。 - **异常**:操作失败抛出 `ConnectionError` 异常。
- `def prepare(self, sql)` - `fn prepare(&mut self, sql: &str) -> PyResult<()>`
- **接口说明**:绑定预编译 sql 语句 - **接口说明**:绑定预编译 sql 语句。
- **参数说明** - **参数说明**
- `sql`: 绑定的 SQL 语句 - `sql`: 预编译的 SQL 语句。
- **异常**:操作失败抛出 `StatementError` 异常。 - **异常**:操作失败抛出 `ProgrammingError` 异常。
- `def bind_param(self, tbnames, tags, datas)` - `fn set_tbname(&mut self, table_name: &str) -> PyResult<()>`
- **接口说明**以独立数组方式绑定数据 - **接口说明**设置将要写入数据的表名。
- **参数说明** - **参数说明**
- `tbnames`: 绑定表名数组,数据类型为 list - `tableName`: 表名,如果需要指定数据库, 例如: `db_name.table_name` 即可。
- `tags`: 绑定 tag 列值数组,数据类型为 list - **异常**:操作失败抛出 `ProgrammingError` 异常。
- `tags`: 绑定普通列值数组,数据类型为 list - `fn set_tags(&mut self, tags: Vec<PyTagView>) -> PyResult<()>`
- **异常**:操作失败抛出 `StatementError` 异常 - **接口说明**:设置表 Tags 数据, 用于自动建表。
- `def bind_param_with_tables(self, tables)`
- **接口说明**以独立表方式绑定数据独立表是以表为组织单位每张表中有表名TAG 值及普通列数值属性
- **参数说明** - **参数说明**
- `tables`: `BindTable` 独立表对象数组 - `paramsArray`: Tags 数据。
- **异常**:操作失败抛出 `StatementError` 异常。 - **异常**:操作失败抛出 `ProgrammingError` 异常。
- `def execute(self) -> int:` - `fn bind_param(&mut self, params: Vec<PyColumnView>) -> PyResult<()>`
- **接口说明**:执行将绑定数据全部写入 - **接口说明**:绑定数据。
- **返回值**:影响行数 - **参数说明**
- `paramsArray`: 绑定数据。
- **异常**:操作失败抛出 `ProgrammingError` 异常。
- `fn add_batch(&mut self) -> PyResult<()>`
- **接口说明**:提交绑定数据。
- **异常**:操作失败抛出 `ProgrammingError` 异常。
- `fn execute(&mut self) -> PyResult<usize>`
- **接口说明**:执行将绑定的数据全部写入。
- **返回值**:写入条数。
- **异常**:操作失败抛出 `QueryError` 异常。 - **异常**:操作失败抛出 `QueryError` 异常。
- `def result(self)` - `fn affect_rows(&mut self) -> PyResult<usize>`
- **接口说明** 获取参数绑定查询结果集 - **接口说明** 获取写入条数。
- **返回值**:返回 TaosResult 对象 - **返回值**:写入条数。
- `def close(self)` - `fn close(&self) -> PyResult<()>`
- **接口说明** 关闭 stmt2 对象 - **接口说明** 关闭 stmt 对象。
#### 数据订阅 #### 数据订阅
@ -424,7 +427,7 @@ TaosResult 对象可以通过循环遍历获取查询到的数据。
- **返回值**:影响的条数。 - **返回值**:影响的条数。
- **异常**:操作失败抛出 `SchemalessError` 异常。 - **异常**:操作失败抛出 `SchemalessError` 异常。
#### 参数绑定 STMT2 #### 参数绑定
- `def statement2(self, sql=None, option=None)` - `def statement2(self, sql=None, option=None)`
- **接口说明**:使用连接对象创建 stmt2 对象 - **接口说明**:使用连接对象创建 stmt2 对象
- **参数说明** - **参数说明**