From d9f0e3f73c6e4a77b04cab463e54adc668834cbc Mon Sep 17 00:00:00 2001
From: sunpeng <sunpeng.dev@gmail.com>
Date: Mon, 3 Jul 2023 11:29:52 +0800
Subject: [PATCH] docs: update python document

---
 .../14-reference/03-connector/07-python.mdx   | 90 ++++++++++-------
 docs/zh/08-connector/30-python.mdx            | 96 +++++++++++--------
 2 files changed, 111 insertions(+), 75 deletions(-)

diff --git a/docs/en/14-reference/03-connector/07-python.mdx b/docs/en/14-reference/03-connector/07-python.mdx
index 43713117f9..2a6cd9ecf7 100644
--- a/docs/en/14-reference/03-connector/07-python.mdx
+++ b/docs/en/14-reference/03-connector/07-python.mdx
@@ -20,6 +20,11 @@ The source code for the Python connector is hosted on [GitHub](https://github.co
 - The [supported platforms](/reference/connector/#supported-platforms) for the native connection are the same as the ones supported by the TDengine client.
 - REST connections are supported on all platforms that can run Python.
 
+### Supported features
+
+- Native connections support all the core features of TDengine, including connection management, SQL execution, bind interface, subscriptions, and schemaless writing.
+- REST connections support features such as connection management and SQL execution. (SQL execution allows you to: manage databases, tables, and supertables, write data, query data, create continuous queries, etc.).
+
 ## Version selection
 
 We recommend using the latest version of `taospy`, regardless of the version of TDengine.
@@ -64,10 +69,23 @@ All exceptions from the Python Connector are thrown directly. Applications shoul
 {{#include docs/examples/python/handle_exception.py}}
 ```
 
-## Supported features
+## TDengine DataType vs. Python DataType
 
-- Native connections support all the core features of TDengine, including connection management, SQL execution, bind interface, subscriptions, and schemaless writing.
-- REST connections support features such as connection management and SQL execution. (SQL execution allows you to: manage databases, tables, and supertables, write data, query data, create continuous queries, etc.).
+TDengine currently supports timestamp, number, character, Boolean type, and the corresponding type conversion with Python is as follows:
+
+|TDengine DataType|Python DataType|
+|:---------------:|:-------------:|
+|TIMESTAMP|datetime|
+|INT|int|
+|BIGINT|int|
+|FLOAT|float|
+|DOUBLE|int|
+|SMALLINT|int|
+|TINYINT|int|
+|BOOL|bool|
+|BINARY|str|
+|NCHAR|str|
+|JSON|str|
 
 ## Installation
 
@@ -544,7 +562,7 @@ Connector support data subscription. For more information about subscroption, pl
 
 The `consumer` in the connector contains the subscription api. 
 
-#### Create Consumer
+##### Create Consumer
 
 The syntax for creating a consumer is `consumer = Consumer(configs)`. For more subscription api parameters, please refer to [Data Subscription](../../../develop/tmq/).
 
@@ -554,7 +572,7 @@ from taos.tmq import Consumer
 consumer = Consumer({"group.id": "local", "td.connect.ip": "127.0.0.1"})
 ```
 
-#### Subscribe topics
+##### Subscribe topics
 
 The `subscribe` function is used to subscribe to a list of topics.
 
@@ -562,7 +580,7 @@ The `subscribe` function is used to subscribe to a list of topics.
 consumer.subscribe(['topic1', 'topic2'])
 ```
 
-#### Consume
+##### Consume
 
 The `poll` function is used to consume data in tmq. The parameter of the `poll` function is a value of type float representing the timeout in seconds. It returns a `Message` before timing out, or `None` on timing out. You have to handle error messages in response data.
 
@@ -580,7 +598,7 @@ while True:
         print(block.fetchall())
 ```
 
-#### assignment
+##### assignment
 
 The `assignment` function is used to get the assignment of the topic. 
 
@@ -588,7 +606,7 @@ The `assignment` function is used to get the assignment of the topic.
 assignments = consumer.assignment()
 ```
 
-#### Seek
+##### Seek
 
 The `seek` function is used to reset the assignment of the topic.
 
@@ -597,7 +615,7 @@ tp = TopicPartition(topic='topic1', partition=0, offset=0)
 consumer.seek(tp)
 ```
 
-#### After consuming data
+##### After consuming data
 
 You should unsubscribe to the topics and close the consumer after consuming.
 
@@ -606,13 +624,13 @@ consumer.unsubscribe()
 consumer.close()
 ```
 
-#### Tmq subscription example
+##### Tmq subscription example
 
 ```python
 {{#include docs/examples/python/tmq_example.py}}
 ```
 
-#### assignment and seek example
+##### assignment and seek example
 
 ```python
 {{#include docs/examples/python/tmq_assignment_example.py:taos_get_assignment_and_seek_demo}}
@@ -624,7 +642,7 @@ consumer.close()
 
 In addition to native connections, the connector also supports subscriptions via websockets.
 
-#### Create Consumer
+##### Create Consumer
 
 The syntax for creating a consumer is "consumer = consumer = Consumer(conf=configs)". You need to specify that the `td.connect.websocket.scheme` parameter is set to "ws" in the configuration. For more subscription api parameters, please refer to [Data Subscription](../../../develop/tmq/#create-a-consumer).
 
@@ -634,7 +652,7 @@ import taosws
 consumer = taosws.(conf={"group.id": "local", "td.connect.websocket.scheme": "ws"})
 ```
 
-#### subscribe topics
+##### subscribe topics
 
 The `subscribe` function is used to subscribe to a list of topics.
 
@@ -642,7 +660,7 @@ The `subscribe` function is used to subscribe to a list of topics.
 consumer.subscribe(['topic1', 'topic2'])
 ```
 
-#### Consume
+##### Consume
 
 The `poll` function is used to consume data in tmq. The parameter of the `poll` function is a value of type float representing the timeout in seconds. It returns a `Message` before timing out, or `None` on timing out. You have to handle error messages in response data.
 
@@ -659,7 +677,7 @@ while True:
             print(row)
 ```
 
-#### assignment
+##### assignment
 
 The `assignment` function is used to get the assignment of the topic. 
 
@@ -667,7 +685,7 @@ The `assignment` function is used to get the assignment of the topic.
 assignments = consumer.assignment()
 ```
 
-#### Seek
+##### Seek
 
 The `seek` function is used to reset the assignment of the topic.
 
@@ -675,7 +693,7 @@ The `seek` function is used to reset the assignment of the topic.
 consumer.seek(topic='topic1', partition=0, offset=0)
 ```
 
-#### After consuming data
+##### After consuming data
 
 You should unsubscribe to the topics and close the consumer after consuming.
 
@@ -684,13 +702,13 @@ consumer.unsubscribe()
 consumer.close()
 ```
 
-#### Subscription example
+##### Subscription example
 
 ```python
 {{#include docs/examples/python/tmq_websocket_example.py}}
 ```
 
-#### Assignment and seek example
+##### Assignment and seek example
 
 ```python
 {{#include docs/examples/python/tmq_websocket_assgnment_example.py:taosws_get_assignment_and_seek_demo}}
@@ -706,19 +724,19 @@ Connector support schemaless insert.
 <Tabs defaultValue="list">
 <TabItem value="list" label="List Insert">
 
-Simple insert
+##### Simple insert
 
 ```python
 {{#include docs/examples/python/schemaless_insert.py}}
 ```
 
-Insert with ttl argument
+##### Insert with ttl argument
 
 ```python
 {{#include docs/examples/python/schemaless_insert_ttl.py}}
 ```
 
-Insert with req_id argument
+##### Insert with req_id argument
 
 ```python
 {{#include docs/examples/python/schemaless_insert_req_id.py}}
@@ -728,19 +746,19 @@ Insert with req_id argument
 
 <TabItem value="raw" label="Raw Insert">
 
-Simple insert
+##### Simple insert
 
 ```python
 {{#include docs/examples/python/schemaless_insert_raw.py}}
 ```
 
-Insert with ttl argument
+##### Insert with ttl argument
 
 ```python
 {{#include docs/examples/python/schemaless_insert_raw_ttl.py}}
 ```
 
-Insert with req_id argument
+##### Insert with req_id argument
 
 ```python
 {{#include docs/examples/python/schemaless_insert_raw_req_id.py}}
@@ -756,7 +774,7 @@ The Python connector provides a parameter binding api for inserting data. Simila
 <Tabs>
 <TabItem value="native" label="native connection">
 
-#### Create Stmt
+##### Create Stmt
 
 Call the `statement` method in `Connection` to create the `stmt` for parameter binding.
 
@@ -767,7 +785,7 @@ conn = taos.connect()
 stmt = conn.statement("insert into log values(?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?)")
 ```
 
-#### parameter binding
+##### parameter binding
 
 Call the `new_multi_binds` function to create the parameter list for parameter bindings.
 
@@ -797,7 +815,7 @@ Call the `bind_param` (for a single row) method or the `bind_param_batch` (for m
 stmt.bind_param_batch(params)
 ```
 
-#### execute sql
+##### execute sql
 
 Call `execute` method to execute sql.
 
@@ -805,13 +823,13 @@ Call `execute` method to execute sql.
 stmt.execute()
 ```
 
-#### Close Stmt
+##### Close Stmt
 
 ```
 stmt.close()
 ```
 
-#### Example
+##### Example
 
 ```python
 {{#include docs/examples/python/stmt_example.py}}
@@ -820,7 +838,7 @@ stmt.close()
 
 <TabItem value="websocket" label="WebSocket connection">
 
-#### Create Stmt
+##### Create Stmt
 
 Call the `statement` method in `Connection` to create the `stmt` for parameter binding.
 
@@ -831,7 +849,7 @@ conn = taosws.connect('taosws://localhost:6041/test')
 stmt = conn.statement()
 ```
 
-#### Prepare sql
+##### Prepare sql
 
 Call `prepare` method in stmt to prepare sql.
 
@@ -839,7 +857,7 @@ Call `prepare` method in stmt to prepare sql.
 stmt.prepare("insert into t1 values (?, ?, ?, ?)")
 ```
 
-#### parameter binding
+##### parameter binding
 
 Call the `bind_param` method to bind parameters.
 
@@ -858,7 +876,7 @@ Call the `add_batch` method to add parameters to the batch.
 stmt.add_batch()
 ```
 
-#### execute sql
+##### execute sql
 
 Call `execute` method to execute sql.
 
@@ -866,13 +884,13 @@ Call `execute` method to execute sql.
 stmt.execute()
 ```
 
-#### Close Stmt
+##### Close Stmt
 
 ```
 stmt.close()
 ```
 
-#### Example
+##### Example
 
 ```python
 {{#include docs/examples/python/stmt_websocket_example.py}}
diff --git a/docs/zh/08-connector/30-python.mdx b/docs/zh/08-connector/30-python.mdx
index 8fdb428384..fcae6e2b6b 100644
--- a/docs/zh/08-connector/30-python.mdx
+++ b/docs/zh/08-connector/30-python.mdx
@@ -22,7 +22,12 @@ Python 连接器的源码托管在 [GitHub](https://github.com/taosdata/taos-con
 - 原生连接[支持的平台](../#支持的平台)和 TDengine 客户端支持的平台一致。
 - REST 连接支持所有能运行 Python 的平台。
 
-## 版本选择
+### 支持的功能
+
+- 原生连接支持 TDengine 的所有核心功能， 包括： 连接管理、执行 SQL、参数绑定、订阅、无模式写入（schemaless）。
+- REST 连接支持的功能包括：连接管理、执行 SQL。 (通过执行 SQL 可以： 管理数据库、管理表和超级表、写入数据、查询数据、创建连续查询等)。
+
+## 历史版本
 
 无论使用什么版本的 TDengine 都建议使用最新版本的 `taospy`。
 
@@ -66,12 +71,25 @@ Python Connector 的所有数据库操作如果出现异常，都会直接抛出
 {{#include docs/examples/python/handle_exception.py}}
 ```
 
-## 支持的功能
+TDengine DataType 和 Python DataType
 
-- 原生连接支持 TDengine 的所有核心功能， 包括： 连接管理、执行 SQL、参数绑定、订阅、无模式写入（schemaless）。
-- REST 连接支持的功能包括：连接管理、执行 SQL。 (通过执行 SQL 可以： 管理数据库、管理表和超级表、写入数据、查询数据、创建连续查询等)。
+TDengine 目前支持时间戳、数字、字符、布尔类型，与 Python 对应类型转换如下：
+
+|TDengine DataType|Python DataType|
+|:---------------:|:-------------:|
+|TIMESTAMP|datetime|
+|INT|int|
+|BIGINT|int|
+|FLOAT|float|
+|DOUBLE|int|
+|SMALLINT|int|
+|TINYINT|int|
+|BOOL|bool|
+|BINARY|str|
+|NCHAR|str|
+|JSON|str|
 
-## 安装
+## 安装步骤
 
 ### 安装前准备
 
@@ -384,7 +402,7 @@ TaosCursor 类使用原生连接进行写入、查询操作。在客户端多线
 </TabItem>
 <TabItem value="websocket" label="WebSocket 连接">
 
-#### Connection 类的使用
+##### Connection 类的使用
 
 `Connection` 类既包含对 PEP249 Connection 接口的实现(如：cursor方法和 close 方法)，也包含很多扩展功能（如： execute、 query、schemaless_insert 和 subscribe 方法。
 
@@ -548,7 +566,7 @@ RestClient 类是对于 REST API 的直接封装。它只包含一个 sql() 方
 
 `Consumer` 提供了 Python 连接器订阅 TMQ 数据的 API。
 
-#### 创建 Consumer
+##### 创建 Consumer
 
 创建 Consumer 语法为 `consumer = Consumer(configs)`，参数定义请参考 [数据订阅文档](../../develop/tmq/#%E5%88%9B%E5%BB%BA%E6%B6%88%E8%B4%B9%E8%80%85-consumer)。
 
@@ -558,7 +576,7 @@ from taos.tmq import Consumer
 consumer = Consumer({"group.id": "local", "td.connect.ip": "127.0.0.1"})
 ```
 
-#### 订阅 topics
+##### 订阅 topics
 
 Consumer API 的 `subscribe` 方法用于订阅 topics，consumer 支持同时订阅多个 topic。
 
@@ -566,7 +584,7 @@ Consumer API 的 `subscribe` 方法用于订阅 topics，consumer 支持同时
 consumer.subscribe(['topic1', 'topic2'])
 ```
 
-#### 消费数据
+##### 消费数据
 
 Consumer API 的 `poll` 方法用于消费数据，`poll` 方法接收一个 float 类型的超时时间，超时时间单位为秒（s），`poll` 方法在超时之前返回一条 Message 类型的数据或超时返回 `None`。消费者必须通过 Message 的 `error()` 方法校验返回数据的 error 信息。
 
@@ -584,7 +602,7 @@ while True:
         print(block.fetchall())
 ```
 
-#### 获取消费进度
+##### 获取消费进度
 
 Consumer API 的 `assignment` 方法用于获取 Consumer 订阅的所有 topic 的消费进度，返回结果类型为 TopicPartition 列表。
 
@@ -592,7 +610,7 @@ Consumer API 的 `assignment` 方法用于获取 Consumer 订阅的所有 topic
 assignments = consumer.assignment()
 ```
 
-#### 重置消费进度
+##### 指定订阅 Offset
 
 Consumer API 的 `seek` 方法用于重置 Consumer 的消费进度到指定位置，方法参数类型为 TopicPartition。
 
@@ -601,7 +619,7 @@ tp = TopicPartition(topic='topic1', partition=0, offset=0)
 consumer.seek(tp)
 ```
 
-#### 结束消费
+##### 关闭订阅
 
 消费结束后，应当取消订阅，并关闭 Consumer。
 
@@ -610,13 +628,13 @@ consumer.unsubscribe()
 consumer.close()
 ```
 
-#### tmq 订阅示例代码
+##### 完整示例
 
 ```python
 {{#include docs/examples/python/tmq_example.py}}
 ```
 
-#### 获取和重置消费进度示例代码
+##### 获取和重置消费进度示例代码
 
 ```python
 {{#include docs/examples/python/tmq_assignment_example.py:taos_get_assignment_and_seek_demo}}
@@ -630,7 +648,7 @@ consumer.close()
 
 taosws `Consumer` API 提供了基于 Websocket 订阅 TMQ 数据的 API。
 
-#### 创建 Consumer
+##### 创建 Consumer
 
 创建 Consumer 语法为 `consumer = Consumer(conf=configs)`，使用时需要指定 `td.connect.websocket.scheme` 参数值为 "ws"，参数定义请参考 [数据订阅文档](../../develop/tmq/#%E5%88%9B%E5%BB%BA%E6%B6%88%E8%B4%B9%E8%80%85-consumer)。
 
@@ -640,7 +658,7 @@ import taosws
 consumer = taosws.(conf={"group.id": "local", "td.connect.websocket.scheme": "ws"})
 ```
 
-#### 订阅 topics
+##### 订阅 topics
 
 Consumer API 的 `subscribe` 方法用于订阅 topics，consumer 支持同时订阅多个 topic。
 
@@ -648,7 +666,7 @@ Consumer API 的 `subscribe` 方法用于订阅 topics，consumer 支持同时
 consumer.subscribe(['topic1', 'topic2'])
 ```
 
-#### 消费数据
+##### 消费数据
 
 Consumer API 的 `poll` 方法用于消费数据，`poll` 方法接收一个 float 类型的超时时间，超时时间单位为秒（s），`poll` 方法在超时之前返回一条 Message 类型的数据或超时返回 `None`。消费者必须通过 Message 的 `error()` 方法校验返回数据的 error 信息。
 
@@ -665,7 +683,7 @@ while True:
             print(row)
 ```
 
-#### 获取消费进度
+##### 获取消费进度
 
 Consumer API 的 `assignment` 方法用于获取 Consumer 订阅的所有 topic 的消费进度，返回结果类型为 TopicPartition 列表。
 
@@ -673,7 +691,7 @@ Consumer API 的 `assignment` 方法用于获取 Consumer 订阅的所有 topic
 assignments = consumer.assignment()
 ```
 
-#### 重置消费进度
+##### 重置消费进度
 
 Consumer API 的 `seek` 方法用于重置 Consumer 的消费进度到指定位置。
 
@@ -681,7 +699,7 @@ Consumer API 的 `seek` 方法用于重置 Consumer 的消费进度到指定位
 consumer.seek(topic='topic1', partition=0, offset=0)
 ```
 
-#### 结束消费
+##### 结束消费
 
 消费结束后，应当取消订阅，并关闭 Consumer。
 
@@ -690,7 +708,7 @@ consumer.unsubscribe()
 consumer.close()
 ```
 
-#### tmq 订阅示例代码
+##### tmq 订阅示例代码
 
 ```python
 {{#include docs/examples/python/tmq_websocket_example.py}}
@@ -698,7 +716,7 @@ consumer.close()
 
 连接器提供了 `assignment` 接口，用于获取 topic assignment 的功能，可以查询订阅的 topic 的消费进度，并提供 `seek` 接口，用于重置 topic 的消费进度。
 
-#### 获取和重置消费进度示例代码
+##### 获取和重置消费进度示例代码
 
 ```python
 {{#include docs/examples/python/tmq_websocket_assgnment_example.py:taosws_get_assignment_and_seek_demo}}
@@ -714,19 +732,19 @@ consumer.close()
 <Tabs defaultValue="list">
 <TabItem value="list" label="List 写入">
 
-简单写入
+##### 简单写入
 
 ```python
 {{#include docs/examples/python/schemaless_insert.py}}
 ```
 
-带有 ttl 参数的写入
+##### 带有 ttl 参数的写入
 
 ```python
 {{#include docs/examples/python/schemaless_insert_ttl.py}}
 ```
 
-带有 req_id 参数的写入
+##### 带有 req_id 参数的写入
 
 ```python
 {{#include docs/examples/python/schemaless_insert_req_id.py}}
@@ -736,19 +754,19 @@ consumer.close()
 
 <TabItem value="raw" label="Raw 写入">
 
-简单写入
+##### 简单写入
 
 ```python
 {{#include docs/examples/python/schemaless_insert_raw.py}}
 ```
 
-带有 ttl 参数的写入
+##### 带有 ttl 参数的写入
 
 ```python
 {{#include docs/examples/python/schemaless_insert_raw_ttl.py}}
 ```
 
-带有 req_id 参数的写入
+##### 带有 req_id 参数的写入
 
 ```python
 {{#include docs/examples/python/schemaless_insert_raw_req_id.py}}
@@ -764,7 +782,7 @@ TDengine 的 Python 连接器支持参数绑定风格的 Prepare API 方式写
 <Tabs>
 <TabItem value="native" label="原生连接">
 
-#### 创建 stmt
+##### 创建 stmt
 
 Python 连接器的 `Connection` 提供了 `statement` 方法用于创建参数绑定对象 stmt，该方法接收 sql 字符串作为参数，sql 字符串目前仅支持用 `?` 来代表绑定的参数。
 
@@ -775,7 +793,7 @@ conn = taos.connect()
 stmt = conn.statement("insert into log values(?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?)")
 ```
 
-#### 参数绑定
+##### 参数绑定
 
 调用 `new_multi_binds` 函数创建 params 列表，用于参数绑定。
 
@@ -805,7 +823,7 @@ params[15].timestamp([None, None, 1626861392591])
 stmt.bind_param_batch(params)
 ```
 
-#### 执行 sql
+##### 执行 sql
 
 调用 stmt 的 `execute` 方法执行 sql
 
@@ -813,7 +831,7 @@ stmt.bind_param_batch(params)
 stmt.execute()
 ```
 
-#### 关闭 stmt
+##### 关闭 stmt
 
 最后需要关闭 stmt。
 
@@ -821,7 +839,7 @@ stmt.execute()
 stmt.close()
 ```
 
-#### 示例代码
+##### 示例代码
 
 ```python
 {{#include docs/examples/python/stmt_example.py}}
@@ -830,7 +848,7 @@ stmt.close()
 
 <TabItem value="websocket" label="WebSocket 连接">
 
-#### 创建 stmt
+##### 创建 stmt
 
 Python WebSocket 连接器的 `Connection` 提供了 `statement` 方法用于创建参数绑定对象 stmt，该方法接收 sql 字符串作为参数，sql 字符串目前仅支持用 `?` 来代表绑定的参数。
 
@@ -841,7 +859,7 @@ conn = taosws.connect('taosws://localhost:6041/test')
 stmt = conn.statement()
 ```
 
-#### 解析 sql
+##### 解析 sql
 
 调用 stmt 的 `prepare` 方法来解析 insert 语句。
 
@@ -849,7 +867,7 @@ stmt = conn.statement()
 stmt.prepare("insert into t1 values (?, ?, ?, ?)")
 ```
 
-#### 参数绑定
+##### 参数绑定
 
 调用 stmt 的 `bind_param` 方法绑定参数。
 
@@ -868,7 +886,7 @@ stmt.bind_param([
 stmt.add_batch()
 ```
 
-#### 执行 sql
+##### 执行 sql
 
 调用 stmt 的 `execute` 方法执行 sql
 
@@ -876,7 +894,7 @@ stmt.add_batch()
 stmt.execute()
 ```
 
-#### 关闭 stmt
+##### 关闭 stmt
 
 最后需要关闭 stmt。
 
@@ -884,7 +902,7 @@ stmt.execute()
 stmt.close()
 ```
 
-#### 示例代码
+##### 示例代码
 
 ```python
 {{#include docs/examples/python/stmt_websocket_example.py}}
-- 
GitLab